<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Javadox</title>
<link rel="stylesheet" type="text/css" media="all" href="styles.css"/>
</head>
<body>

<h1>javadox</h1>

<p>Javadoc Crossreferencing Browser - cross-referencing multiple javadoc
documents together.</p>

<hr/>

<p><a href="http://code.google.com/p/javadox/">Javadox</a> cross-references
multiple javadoc documents together. The suffix "x" reads like the plurality
form and means Xross-referenced javadocs.</p>

<p>To not remake the wheel, more and more java projects reuse other existing
projects. However, the generated documents usually contains stuffs of current
project only. This causes navigation interruption when referencing to other
projects. Developers has to stop navigating and google for what package the
return/parameter type is.</p>

<p>Although the javadoc generator do provide the <tt>--link</tt> and
<tt>--linkoffline</tt> options to link to external documents, the required
bootstraping process make them hard to maintain. As a result, only JDK are
cross-referenced, which is quite useless for developers familiar to JDK
already.</p>

<p>The javadox browser is a single-page-application that leverage client-side
technologies to crossreferencing multiple javadoc documents together. No
sepcial requirement on server-side, we can even run the brower in local
machine.</p>

<p>This project is currently under prove-of-concept stage. Welcome to join the
<a href="http://groups.google.com/group/javadox-devel">javadox-devel</a>
mailing list for discussion.</p>

</body>
</html>
